sourceview.Style source code

1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module sourceview.Style;
26 
27 private import gobject.ObjectG;
28 private import gtk.TextTag;
29 private import sourceview.c.functions;
30 public  import sourceview.c.types;
31 
32 
33 /**
34  * Represents a style.
35  * 
36  * The `GtkSourceStyle` structure is used to describe text attributes
37  * which are set when given style is used.
38  */
39 public class Style : ObjectG
40 {
41 	/** the main Gtk struct */
42 	protected GtkSourceStyle* gtkSourceStyle;
43 
44 	/** Get the main Gtk struct */
45 	public GtkSourceStyle* getStyleStruct(bool transferOwnership = false)
46 	{
47 		if (transferOwnership)
48 			ownedRef = false;
49 		return gtkSourceStyle;
50 	}
51 
52 	/** the main Gtk struct as a void* */
53 	protected override void* getStruct()
54 	{
55 		return cast(void*)gtkSourceStyle;
56 	}
57 
58 	/**
59 	 * Sets our main struct and passes it to the parent class.
60 	 */
61 	public this (GtkSourceStyle* gtkSourceStyle, bool ownedRef = false)
62 	{
63 		this.gtkSourceStyle = gtkSourceStyle;
64 		super(cast(GObject*)gtkSourceStyle, ownedRef);
65 	}
66 
67 
68 	/** */
69 	public static GType getType()
70 	{
71 		return gtk_source_style_get_type();
72 	}
73 
74 	/**
75 	 * This function modifies the [class@Gtk.TextTag] properties that are related to the
76 	 * #GtkSourceStyle properties. Other [class@Gtk.TextTag] properties are left untouched.
77 	 *
78 	 * If @style is non-%NULL, applies @style to @tag.
79 	 *
80 	 * If @style is %NULL, the related *-set properties of [class@Gtk.TextTag] are set to
81 	 * %FALSE.
82 	 *
83 	 * Params:
84 	 *     tag = a #GtkTextTag to apply styles to.
85 	 */
86 	public void apply(TextTag tag)
87 	{
88 		gtk_source_style_apply(gtkSourceStyle, (tag is null) ? null : tag.getTextTagStruct());
89 	}
90 
91 	/**
92 	 * Creates a copy of @style, that is a new #GtkSourceStyle instance which
93 	 * has the same attributes set.
94 	 *
95 	 * Returns: copy of @style, call g_object_unref()
96 	 *     when you are done with it.
97 	 */
98 	public Style copy()
99 	{
100 		auto __p = gtk_source_style_copy(gtkSourceStyle);
101 
102 		if(__p is null)
103 		{
104 			return null;
105 		}
106 
107 		return ObjectG.getDObject!(Style)(cast(GtkSourceStyle*) __p, true);
108 	}
109 }